Added guides to environment management - #8
Conversation
✅ Deploy Preview for earthscope-geolab-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
sarahw-earthscope
left a comment
sarahw-earthscope
left a comment
There was a problem hiding this comment.
The content of the new pages is fantastic!
The organization of the whole section now feels chaotic, however. What started as a single page of bullet-summary followed by expanded details for each option, now just feels super redundant with those more detailed options linking out to more pages. I'd love to see one overhead page with a brief summary of the different installation options (this should help users differentiate their use case), and then link to the sub-page for the guide on each one.
There was a problem hiding this comment.
Please see notes linked in the jira ticket for suggested improvements to make this easier for first-time image builders to follow.
sarahw-earthscope
left a comment
sarahw-earthscope
left a comment
There was a problem hiding this comment.
See notes linked in the jira ticket for suggested improvements to make this easier for first-time image builders to follow.
sarahw-earthscope
left a comment
sarahw-earthscope
left a comment
There was a problem hiding this comment.
Content looks really good, just a few suggestions on reorganizing some pieces to make the forks more apparent to new users.
| %pip install pkgname | ||
| ``` | ||
|
|
||
| For more information about managing environments, go to [`Managing Environments`](./managing_environments.md) for detailed instructions. |
There was a problem hiding this comment.
The link text should match the title of the target page. It's very confusing that the page titled 'Managing Environments' (this one) is not the one named managing_environments.md , and that page is named something else.
|
|
||
| While this is the simplest method for building and running a custom image, GeoLab builds the image every time. The build process can take some time and is not ideal for multiple users. By contrast, an image in a repository is pulled directly into JupyterHub and started without waiting for it to be built. | ||
|
|
||
| For more information about using Binder, go to [`Binder for Images`](./binder_for_images.md) for detailed instructions on building a repository that works with Binder. |
There was a problem hiding this comment.
Same here, please make sure the link text matches the page title
|
|
||
| Think of an **image** as a recipe and a **container** as a meal made from that recipe. The recipe doesn't change; you can make the same meal over and over. GeoLab does the same thing: it takes your image and launches a fresh session from it every time. | ||
|
|
||
| Install Python packages in an image by editing plaintext files that list the required software. A tool called `Docker` reads those files and builds the image. The image must be published in an image repository so GeoLab can access it. Here is the process: |
There was a problem hiding this comment.
Add a sentence or two about non-python packages.
| Install Python packages in an image by editing plaintext files that list the required software. A tool called `Docker` reads those files and builds the image. The image must be published in an image repository so GeoLab can access it. Here is the process: | ||
|
|
||
| ```text | ||
| Edit config files → Docker builds → Image → Push image to repository → GeoLab runs it |
There was a problem hiding this comment.
This shows up as a line of code with a scroll bar depending on window width. An ordered list or a table might be a better display option.
|
|
||
| --- | ||
|
|
||
| ## Amazon Web Services Public Elastic Container Registry (ECR) |
There was a problem hiding this comment.
This should either be a separate page, OR needs a section link from the top of the page to jump straight to here without scrolling through all the GHCR instructions
|
|
||
| ### Getting Public ECR Credentials | ||
|
|
||
| Authenticate Docker to a public ECR registry. Use the `ecr-public` command, and note that the region **must** be `us-east-1`: |
There was a problem hiding this comment.
| Authenticate Docker to a public ECR registry. Use the `ecr-public` command, and note that the region **must** be `us-east-1`: | |
| Authenticate Docker to a public ECR registry. Use the `ecr-public` command, and note that the region **must** be `us-east-1` for authentication, regardless of the region you regularly work in. |
|
|
||
| --- | ||
|
|
||
| ## GeoLab Binder vs. Custom Image |
There was a problem hiding this comment.
I think this context and table might belong on the environment management index page to help someone choose the right fork before diving into the build instructions. It doesn't hurt to reiterate here to help someone confirm they're in the right place... but they need this information before diving into a custome image build, too.
2 participants
added binder_for_images.md, building_custom_images.md, and managing_environments.md